home *** CD-ROM | disk | FTP | other *** search
/ Aminet 15 / Aminet 15 - Nov 1996.iso / Aminet / dev / gcc / ixemsdk.lha / man / cat2 / recv.0 < prev    next >
Text File  |  1996-09-01  |  8KB  |  148 lines
  1.  
  2. RECV(2)                    UNIX Programmer's Manual                    RECV(2)
  3.  
  4. NNAAMMEE
  5.      rreeccvv, rreeccvvffrroomm, rreeccvvmmssgg - receive a message from a socket
  6.  
  7. SSYYNNOOPPSSIISS
  8.      ##iinncclluuddee <<ssyyss//ttyyppeess..hh>>
  9.      ##iinncclluuddee <<ssyyss//ssoocckkeett..hh>>
  10.  
  11.      _s_s_i_z_e___t
  12.      rreeccvv(_i_n_t _s, _v_o_i_d _*_b_u_f, _s_i_z_e___t _l_e_n, _i_n_t _f_l_a_g_s)
  13.  
  14.      _s_s_i_z_e___t
  15.      rreeccvvffrroomm(_i_n_t _s, _v_o_i_d _*_b_u_f, _s_i_z_e___t _l_e_n, _i_n_t _f_l_a_g_s, _s_t_r_u_c_t _s_o_c_k_a_d_d_r _*_f_r_o_m,
  16.              _i_n_t _*_f_r_o_m_l_e_n)
  17.  
  18.      _s_s_i_z_e___t
  19.      rreeccvvmmssgg(_i_n_t _s, _s_t_r_u_c_t _m_s_g_h_d_r _*_m_s_g, _i_n_t _f_l_a_g_s)
  20.  
  21. DDEESSCCRRIIPPTTIIOONN
  22.      RReeccvvffrroomm() and rreeccvvmmssgg() are used to receive messages from a socket, and
  23.      may be used to receive data on a socket whether or not it is connection-
  24.      oriented.
  25.  
  26.      If _f_r_o_m is non-nil, and the socket is not connection-oriented, the source
  27.      address of the message is filled in.  _F_r_o_m_l_e_n is a value-result parame-
  28.      ter, initialized to the size of the buffer associated with _f_r_o_m, and mod-
  29.      ified on return to indicate the actual size of the address stored there.
  30.  
  31.      The rreeccvv() call is normally used only on a _c_o_n_n_e_c_t_e_d socket (see
  32.      connect(2))  and is identical to rreeccvvffrroomm() with a nil _f_r_o_m parameter.
  33.      As it is redundant, it may not be supported in future releases.
  34.  
  35.      All three routines return the length of the message on successful comple-
  36.      tion.  If a message is too long to fit in the supplied buffer, excess
  37.      bytes may be discarded depending on the type of socket the message is re-
  38.      ceived from (see socket(2)).
  39.  
  40.      If no messages are available at the socket, the receive call waits for a
  41.      message to arrive, unless the socket is nonblocking (see fcntl(2))  in
  42.      which case the value -1 is returned and the external variable _e_r_r_n_o set
  43.      to EAGAIN. The receive calls normally return any data available, up to
  44.      the requested amount, rather than waiting for receipt of the full amount
  45.      requested; this behavior is affected by the socket-level options
  46.      SO_RCVLOWAT and SO_RCVTIMEO described in getsockopt(2).
  47.  
  48.      The select(2) call may be used to determine when more data arrive.
  49.  
  50.      The _f_l_a_g_s argument to a recv call is formed by _o_r'ing one or more of the
  51.      values:
  52.  
  53.            MSG_OOB        process out-of-band data
  54.            MSG_PEEK       peek at incoming message
  55.            MSG_WAITALL    wait for full request or error
  56.      The MSG_OOB flag requests receipt of out-of-band data that would not be
  57.      received in the normal data stream.  Some protocols place expedited data
  58.      at the head of the normal data queue, and thus this flag cannot be used
  59.      with such protocols.  The MSG_PEEK flag causes the receive operation to
  60.      return data from the beginning of the receive queue without removing that
  61.      data from the queue.  Thus, a subsequent receive call will return the
  62.      same data.  The MSG_WAITALL flag requests that the operation block until
  63.      the full request is satisfied.  However, the call may still return less
  64.      data than requested if a signal is caught, an error or disconnect occurs,
  65.      or the next data to be received is of a different type than that re-
  66.      turned.
  67.  
  68.      The rreeccvvmmssgg() call uses a _m_s_g_h_d_r structure to minimize the number of di-
  69.      rectly supplied parameters.  This structure has the following form, as
  70.      defined in <_s_y_s_/_s_o_c_k_e_t_._h>:
  71.  
  72.      struct msghdr {
  73.              caddr_t msg_name;       /* optional address */
  74.              u_int   msg_namelen;    /* size of address */
  75.              struct  iovec *msg_iov; /* scatter/gather array */
  76.              u_int   msg_iovlen;     /* # elements in msg_iov */
  77.              caddr_t msg_control;    /* ancillary data, see below */
  78.              u_int   msg_controllen; /* ancillary data buffer len */
  79.              int     msg_flags;      /* flags on received message */
  80.      };
  81.  
  82.      Here _m_s_g___n_a_m_e and _m_s_g___n_a_m_e_l_e_n specify the destination address if the
  83.      socket is unconnected; _m_s_g___n_a_m_e may be given as a null pointer if no
  84.      names are desired or required.  _M_s_g___i_o_v and _m_s_g___i_o_v_l_e_n describe scatter
  85.      gather locations, as discussed in read(2).  _M_s_g___c_o_n_t_r_o_l, which has length
  86.      _m_s_g___c_o_n_t_r_o_l_l_e_n, points to a buffer for other protocol control related
  87.      messages or other miscellaneous ancillary data.  The messages are of the
  88.      form:
  89.  
  90.      struct cmsghdr {
  91.              u_int   cmsg_len;       /* data byte count, including hdr */
  92.              int     cmsg_level;     /* originating protocol */
  93.              int     cmsg_type;      /* protocol-specific type */
  94.      /* followed by
  95.              u_char  cmsg_data[]; */
  96.      };
  97.      As an example, one could use this to learn of changes in the data-stream
  98.      in XNS/SPP, or in ISO, to obtain user-connection-request data by request-
  99.      ing a recvmsg with no data buffer provided immediately after an aacccceepptt()
  100.      call.
  101.  
  102.      Open file descriptors are now passed as ancillary data for AF_UNIX domain
  103.      sockets, with _c_m_s_g___l_e_v_e_l set to SOL_SOCKET and _c_m_s_g___t_y_p_e set to
  104.      SCM_RIGHTS.
  105.  
  106.      The _m_s_g___f_l_a_g_s field is set on return according to the message received.
  107.      MSG_EOR indicates end-of-record; the data returned completed a record
  108.      (generally used with sockets of type SOCK_SEQPACKET). MSG_TRUNC indicates
  109.      that the trailing portion of a datagram was discarded because the data-
  110.      gram was larger than the buffer supplied.  MSG_CTRUNC indicates that some
  111.      control data were discarded due to lack of space in the buffer for ancil-
  112.      lary data.  MSG_OOB is returned to indicate that expedited or out-of-band
  113.      data were received.
  114.  
  115. RREETTUURRNN VVAALLUUEESS
  116.      These calls return the number of bytes received, or -1 if an error oc-
  117.      curred.
  118.  
  119. EERRRROORRSS
  120.      The calls fail if:
  121.  
  122.      [EBADF]       The argument _s is an invalid descriptor.
  123.  
  124.      [ENOTCONN]    The socket is associated with a connection-oriented proto-
  125.                    col and has not been connected (see connect(2) and
  126.                    accept(2)).
  127.  
  128.      [ENOTSOCK]    The argument _s does not refer to a socket.
  129.  
  130.      [EAGAIN]      The socket is marked non-blocking, and the receive opera-
  131.                    tion would block, or a receive timeout had been set, and
  132.  
  133.                    the timeout expired before data were received.
  134.  
  135.      [EINTR]       The receive was interrupted by delivery of a signal before
  136.                    any data were available.
  137.  
  138.      [EFAULT]      The receive buffer pointer(s) point outside the process's
  139.                    address space.
  140.  
  141. SSEEEE AALLSSOO
  142.      fcntl(2),  read(2),  select(2),  getsockopt(2),  socket(2)
  143.  
  144. HHIISSTTOORRYY
  145.      The rreeccvv() function call appeared in 4.2BSD.
  146.  
  147. 4.3-Reno Berkeley Distribution February 21, 1994                             3
  148.